home *** CD-ROM | disk | FTP | other *** search
/ BBS Toolkit / BBS Toolkit.iso / pc_board / lmp01a.zip / MASTER.DOC < prev    next >
Text File  |  1993-04-18  |  23KB  |  476 lines
  1.  
  2.  
  3.  
  4.  
  5. ───────────────────────────────────────────────────────────────────────────────
  6.        ListMaster Pro v0.1a  |  Garrett Whitney  |  Gamma Software Design
  7. ───────────────────────────────────────────────────────────────────────────────
  8.  
  9.                            Master File List Generator
  10.                                   Version 0.1a
  11.                            Written By Garrett Whitney
  12.                               Gamma Software Design
  13.                                    ShareWare
  14.  
  15.  
  16.                      Written and Compiled in QuickBasic 4.5
  17.                        Compiled on Sunday April 18, 1993
  18.                            For use with most any BBS
  19.  
  20.  
  21.  
  22.  
  23.  
  24.  
  25.  
  26.  
  27.  
  28.  
  29.  
  30.   Table of Content's ............................................... Page
  31.  
  32.   Shareware & Registration Information ................................ 1
  33.   Version Updates ..................................................... 2
  34.   The Configuration File & Setup ...................................... 3
  35.   PcBoard Configuration Editor ........................................ 4
  36.   Command Line Execution .............................................. 5
  37.   Future Releases ..................................................... 6
  38.   Special Note ........................................................ 7
  39.   Contacting the Author ............................................... 8
  40.  
  41.  
  42.  
  43.  
  44.  
  45.  
  46.  
  47.  
  48.  
  49.         Page 1 - Shareware & Registration Information
  50.  
  51.  
  52.         ListMaster is a Shareware Program which means that you may use this
  53.  program free for a limited time, then you must register it. You may use this
  54.  program free for 30 days, after your 30 day trial period, you must register
  55.  it. Registration for ListMaster is only $5. Just fill out Register.Txt
  56.  and mail it to me with a check or money order. Since this is Distributed as
  57.  Shareware, I can not Garauntee that it is free of harm. Therefore i take no
  58.  responsibility for any damages which this program may cause. (Pretty
  59.  ir-responsible of me huh? I bet you heard your parent's say that to you a few
  60.  times!) I am not going to say that this program is error free either. If you
  61.  find an error, please let me know about it so i can fix it.
  62.  
  63.         Registering ListMaster is easy and inexpensive. Just fill out
  64.  Register.Txt and mail it to me with a check or money order made out for $5
  65.  to Garrett Whitney. What this registration will do is tell me who is
  66.  interested in my program and wether I should continue to distribute future
  67.  version's or not. The $5 registration fee will also allow you free updates.
  68.  Once you have sent in your registration fee, you will only be asked to pay
  69.  for shipping and handling. You can also call a board carrying ListMaster Pro
  70.  and download it which will probably cost less. The $5 entitles you to free
  71.  updates and any help you need. I provide technical support through BBS, mail,
  72.  phone, or whatever you want to work out. This is a one time fee.
  73.  
  74.  
  75.  
  76.         Page 2 - Version Update's
  77.  
  78.  
  79.                            ListMaster v0.1a Updates
  80.  
  81.         * A Configuration editor has now been added for PcBoard user's.
  82.  
  83.         * Ansi & ASCii bulletins are now an option. They will be produced
  84.           after every run.
  85.  
  86.         * A Colorized version of the master file list is available. This
  87.           version is colorized with PcBoard color codes. It is then internally
  88.           compressed. A special viewer is needed for the user to view this
  89.           file.
  90.  
  91.         * A colorized/compressed file viewer is included for users to download.
  92.           This viewer will view the compressed/color listing.
  93.  
  94.  
  95.  
  96.         Page 3 - The Configuration File
  97.  
  98.  
  99.                            The Configuration File
  100.  
  101.    Line 1 ->  Gamma Programming Northwest Bulletin Board System
  102.    Line 2 ->  Garrett Whitney
  103.    Line 3 ->  Gamma Programming BBS - OPEN 10pm - 7am ONLY - (206) 830-0314
  104.    Line 4 ->  000000000
  105.    Line 5 ->  PCBLIST
  106.    Line 6 ->  196
  107.    Line 7 ->  skip
  108.    Line 8 ->  D:\FILES\01\GPNFILE.LST
  109.    Line 9 ->  PcBoard
  110.    Line 10 -> none
  111.    Line 11 -> none
  112.    Line 12 -> N                                 <- New Addition
  113.    Line 13 -> GPNFILE.CMP                       <- New Addition
  114.    Line 14 -> 0                                 <- New Addition
  115.    Line 15 -> 0                                 <- New Addition
  116.    Line 16 -> 0                                 <- New Addition
  117.    Line 17 -> 0                                 <- New Addition
  118.    Line 18 -> Y                                 <- New Addition
  119.    Line 19 -> BLT1                              <- New Addition
  120.    Line 20 -> BLT1G                             <- New Addition
  121.    Line 21 -> 1
  122.    Line 22 -> Gamma Programming Information
  123.    Line 23 -> D:\FILES\01\
  124.  
  125.         This is just an example of a configuration file that is used by
  126.  ListMaster. This is the Configuration that can be found in MASTER.CFG which
  127.  should be located in the Archive. With all of the feature's being added each
  128.  update, the CFG is getting pretty complicated. I will try and explain wich
  129.  line's are new addition's.
  130.  
  131.         Line 1 is just the Name of your BBS. This will be placed in the output
  132.  file in the header as well as on the screen while ListMaster is running.
  133.  
  134.         Line 2 is the name of the Sysop which will be placed in the header of
  135.  the output file.
  136.  
  137.         Line 3 is a one line description that will be placed in the header of
  138.  the output file. I use this for the hour's of my BBS. You can use it for
  139.  anything: Description, Membership Price's, Phone Number, etc... I figured
  140.  one line would be enough. Especially with the two include files available.
  141.  If you think more description lines would make a big difference in your
  142.  Master List then let me know. I can always add something to allow you as
  143.  meny lines as you want.
  144.  
  145.         Line 4 is where you put your Registration Code when you get it.
  146.  It does not matter what you put here but it is probably best to leave it as
  147.  it is. The Registration code removes the UNREGISTERED Evaluation Copy at the
  148.  end of execution and the 10 second delay. You will receive your registration
  149.  code when I receive your registration fee and form. Your registration code
  150.  will be processed the next business day.
  151.  
  152.         Line 5 is the name of the File List that ListMaster will be reading
  153.  from to get the file's to place in the output file. For PcBoard, you are
  154.  allowed to use different List Filename's. If you do this, you will be able
  155.  to get around this feature by leaving this line blank and adding the
  156.  List Filename onto the Path. Example for Line 23 put D:\FILES\01\PCBLIST
  157.  This will work, I finally decided to see if it would and it did, thanks
  158.  to the fine structuring the program has. Man, what a good author ListMaster
  159.  has! Just kiddin.
  160.  
  161.         Line 6 is an option that will allow you to customize your output file.
  162.  You may place a number here from 1 to 255. This number specifies a character
  163.  in the ASCii character chart. A total of fifty of these characters will be
  164.  placed under the File Area title when the master list is made. Look for a
  165.  program called ASCii.exe for a list of ASCii character's or just play with
  166.  it. You can see what a number will look like by holding down your ALT key
  167.  and typing in the number you want. This will work in DOS and most text
  168.  editors.
  169.                  196 = Single Line (─)   205 = double Line (═)
  170.  
  171.         Line 7 is the Archive command which is very flexable. You may
  172.  specify any acceptable DOS command on this line. You may place a command
  173.  or a batch file to run. I do NOT recommend specifying to run another
  174.  Executable program here unless it is something small like an archiveing tool.
  175.  An example would be:
  176.         PkZip D:\Files\01\GPNFILE D:\Files\01\GPNFILE.LST
  177.  This would create the Zip File GPNFILE.ZIP and include the Master List
  178.  GPNFILE.LST. For more information on using PkZip, consult your manual.
  179.  If one command line will not do what you want then specifying a Batch file
  180.  would be in your best interest. Make sure you either specify the path to the
  181.  batch to execute or the batch file reside's in the same directory as
  182.  Master.Exe. Example:
  183.         \Batch\LMZIP.BAT   <- This would run LMZIP.BAT in the directory called
  184.  Batch on the current drive.
  185.  Any archiving tool may be used on this line since basically, it is just
  186.  executing this line on the DOS command prompt. If you do not want to use this
  187.  option then just put the word SKIP on this line. SKIP will tell ListMaster
  188.  to skip this option.
  189.  
  190.         Line 8  is the path + filename you want ListMaster to generate as an
  191.  output file. This is the Master File Listing that is the outcome of
  192.  ListMaster. Be sure to include the path and drive or else you will end up
  193.  with a master file listing in the current directory.
  194.  
  195.         Line 9 the Type of List you have. It can be one of three thing's.
  196.  
  197.         ASCii -> This is for plain ASCii Text List's. These will basically
  198.         just be copied into the Master Listing. If your file list's are
  199.         readable then try this one and see how it turns out. If it doesn't
  200.         work then try the other options as well. It might work out. If none
  201.         of the BBS format's listed below work for your software, contact the
  202.         author and your software will be added to the support list if possible.
  203.  
  204.         Spitfire -> This should be used if you use the  code's in your
  205.         File List's. I hate how Spitfire uses that to seperate line's but
  206.         you have to live with it. You should use this feature if you have
  207.         's in your File List's. It is a little slower this way but it
  208.         look's nicer than with the little  faces in it. Your output list
  209.         will be formated to the same way it is when Spitfire list's a file
  210.         list to an on-line user.
  211.  
  212.         PcBoard -> This option will do the same as ASCii but will take out
  213.         the little pipe character's (|) before putting it into the Master
  214.         List. This will also remove anything after a % sign.
  215.         So if you use the WGM-DMS program that create's a header for your file
  216.         area's and you have it configured to keep the header in another
  217.         directory then WGM-DMS will put a %(path) line at the beginning of
  218.         your file list. The PCBOARD option will read the % sign and ignore
  219.         the line starting from the % sign to the end of the line.
  220.  
  221.         Line 10 is a File that you may include at the beginning of your Master
  222.  File listing. After the Header is placed in the output file, ListMaster will
  223.  read in this file and place it exactly into the output file then begin listing
  224.  the file list's. An opening screen or short new's file would be good for this
  225.  option. If you do not want to use this option then put the word NONE on this
  226.  line.
  227.  
  228.         Line 11 is a File that you may include at the end of your File
  229.  Listing's. After the File Listing's are done, ListMaster will check for this
  230.  file. If there is a file specified here, ListMaster will copy it line for line
  231.  to the output file. This way you can put an ANSI file or something in here but
  232.  it is adviseable that it just be a plain ASCii text file. I use it for a news
  233.  file or something similar. Use your imagination. If you do not want a file
  234.  to be placed at the end of the List, then just put the word NONE on this line.
  235.  
  236.         Line 12 is whether you want to create a compressed/color list.
  237.  You may either put a Y or N on this line. Currently this option is unfinished.
  238.  Only a colorized list will be made, it will not be compressed.
  239.  
  240.         Line 13 is the name of the Color/Compressed list and the path of where
  241.  you want it written to. This file will be a copy of your master file list but
  242.  it will have PcBoard color codes in it (See Lines 14-17). After the color
  243.  have been added, the list will be compressed internally. Your users will have
  244.  to download the specialized list viewer for this file. The list viewer was not
  245.  included in this version though as the list is not compressed. Once the user
  246.  has the file viewer, they can download this list and view it off-line.
  247.  They will have the option of color as well as saving space on your drive and
  248.  the users drive. There is more information on the File Viewer later in this
  249.  document.
  250.  
  251.         Line 14 is the PcBoard code for the Normal Background color in the
  252.  color/compressed listing. (See list below) If you specified N on line 13
  253.  then you should put a 0 on lines 14 through 17.
  254.  
  255.         Line 15 is the PcBoard code for Normal Foreground color.
  256.  
  257.         Line 16 is the PcBoard code for Highlited Background color.
  258.  
  259.         Line 17 is the PcBoard code for Highlited Foreground color.
  260.  
  261.     PcBoard color code chart ->
  262.  
  263.     Background (first digit)      Foreground (second digit)
  264.     ------------------------      -------------------------
  265.     Black   =  0                   Black   =  0
  266.     Blue    =  1                   Blue    =  1
  267.     Green   =  2                   Green   =  2
  268.     Cyan    =  3                   Cyan    =  3
  269.     Red     =  4                   Red     =  4
  270.     Magenta =  5                   Magenta =  5
  271.     Yellow  =  6                   Yellow  =  6
  272.     White   =  7                   White   =  7
  273.  
  274.     Background w/Blinking          High Intensity Foregounds
  275.  
  276.     Black   =  8                   Black   =  8
  277.     Blue    =  9                   Blue    =  9
  278.     Green   =  A                   Green   =  A
  279.     Cyan    =  B                   Cyan    =  B
  280.     Red     =  C                   Red     =  C
  281.     Magenta =  D                   Magenta =  D
  282.     Yellow  =  E                   Yellow  =  E
  283.     White   =  F                   White   =  F
  284.  
  285.  
  286.         Line 18 is whether you would like ListMaster to create bulletins for
  287.  you. You may place a Y or N here. If a Y is placed here, both ANSI & ASCii
  288.  bulletins are created. These are internal generation functions.
  289.  
  290.         Line 19 is the path and filename of the ASCii bulletin. The ASCii
  291.  bulletin will be created under this name and path. If you put an N on line
  292.  18 then you should still put something here. Put SKIP or NONE. It doesn't
  293.  matter but to be safe, keep something here.
  294.  
  295.         Line 20 is the path and filename of the ANSI bulletin.
  296.  If you specified N on line 18, you should still put something on this line.
  297.  
  298.         Line 21 is the Total number of File Area's that you want to be listed
  299.  in the Output File. You must not specify more than you actually list below.
  300.  You may have a number that is less than the total listed though.
  301.  An error will occur if you have a larger total number than the total you
  302.  have listed below.
  303.  
  304.         Line 22 and every odd numbered line to the end of the file are similar
  305.  that they are all File Area Topic's. Every odd numbered line from Line 11
  306.  should be the File Area Topic. This will be underlined and the file's listed
  307.  below it.
  308.  
  309.         Line 23 and every even numbered line to the end of the file should
  310.  be the Path to the List File listed in Line 5. You must leave a slash at the
  311.  end of the path. (Example: D:\Files\01\)
  312.         If you run a PcBoard BBS and have different File List Name like
  313.  PCBLIST1 and PCBLIST2 then you will be able to leave Line 5 blank and
  314.  put the List Filename after the slash on these line's. If you do it to one
  315.  then you must do it to all of them though.
  316.  
  317.  
  318.  
  319.         Page 4 - PcBoard Configuration Editor
  320.  
  321.  
  322.         The configuration editor for PcBoard is named PCBCFG.EXE and should
  323.  have been included in the archive. Before actually running PCBCFG, you must
  324.  initialize it. Run the following line:
  325.  
  326.         PCBCFG INIT
  327.  
  328.  This will then ask you for the path and name to your CNAMES. file. Make sure
  329.  you don't put your CNAMES.@@@ file, put the one without an extension. This
  330.  will be written to a file called PCBCFG.DAT, do not erase it unless you
  331.  want to reinitialize. If your CNAMES file moves or has a name change then
  332.  you must run PCBCFG INIT again.
  333.         After running PCBCFG once, a file called MASTER.DAT will be created.
  334.  This file contains info on where your PCBLIST files are placed. It is
  335.  re-written upon each execution of PCBCFG.
  336.         To execute PCBCFG, you must either have an existing CFG or intend to
  337.  create one. If you have an existing configuration file, then you should
  338.  specify the name of the CFG file on the command line as so:
  339.  
  340.         PCBCFG file.cfg
  341.  
  342.  This will load file.cfg as the configuration. If you are editing a file, this
  343.  may be unecessary as it will ask you for a file name inside the program.
  344.  If you are creating a new file, you must either specify a filename on the
  345.  command line or MASTER.CFG will be created as the default.
  346.         Once you have gotten to the title screen, press any key to pass it.
  347.  You should then come to a menu of items 1 to 4. All you must do is type the
  348.  number, do not press enter. Selection 2 does not work at this time and will be
  349.  added in future updates. Selecting 1 will create a new CFG file. If you
  350.  specified an existing file on the command line then that file will be erased
  351.  if you continue. You must exit and execute again with a new CFG file.
  352.  A series of questions will be asked of you. Upon finishing this, you will be
  353.  returned to the main menu. You must then select 3 to edit the directories you
  354.  want listed. Your conferences will be listed at this time, your options are
  355.  to enter a conference number or hit Y. To exit this section you must hit Y
  356.  throughout all of your conference.
  357.         After you have selected a conference the directories in that conference
  358.  are listed. Select the number's you want added and then enter 0 to exit.
  359.  You will then be returned to the conference listing.
  360.         Note that after creating a cfg file, you should get a text editor and
  361.  edit out the line 22 and 23. It is automatically added as a safety feature
  362.  incase you don't add directories. Edit that out and then execute PCBCFG again
  363.  and select your conferences to add. It may be somewhat confusing but you
  364.  should play with it. If you run into any problems then contact me. There
  365.  will probably be a few problems with this program but I tried to get most
  366.  of them fixed.
  367.  
  368.  
  369.  
  370.         Page 5 - Command Line Execution
  371.  
  372.  
  373.                             ListMaster Execution
  374.  
  375.         Now that you have the Configuration File setup, the rest is easy.
  376.  
  377.         If your configuration file is NOT named MASTER.CFG then you MUST
  378.  specify the name of the CFG file on the command line. Example:
  379.  
  380.         MASTER MYFILE.CFG
  381.  
  382.         If MYFILE.CFG is not in the same directory as MASTER.EXE then
  383.  you must also specify the path before the filename.
  384.  
  385.         This will run ListMaster and use MYFILE.CFG for the Configuration
  386.  parameter's. However if you are using MASTER.CFG for the configuration
  387.  file name then all you have to do is execute MASTER.EXE and it will
  388.  automatically look for MASTER.CFG. The rest is automated.
  389.  
  390.  
  391.  
  392.         Page 6 - Future Releases
  393.  
  394.  
  395.         In future releases, I hope to have the following available:
  396.  
  397.         File Viewer for color/compressed list
  398.         Color/Compressed list fully functionable
  399.         CFG Editor for Spitfire
  400.         Improve PcBoard CFG Editor
  401.         Include support for Wildcat! BBS
  402.         Include support for Auntie & RBBS software
  403.         Allow sysop to add SoundBlaster support to Color/Compresse list
  404.         Allow sysop to add EGA/VGA graphics to Color/Compress list
  405.         More to come...Thanks for obtaining this copy!
  406.  
  407.  
  408.  
  409.         Page 7 - A Special Note
  410.  
  411.  
  412.         I would like to thank a few people for there participation in helping
  413.  me create this program. I would like to thank:
  414.  
  415.         Jim Coleman for his help with PcBoard         Sysop Darkstar's BBS
  416.         Darrell Dillard for help with Wildcat!        Sysop Thundercat BBS
  417.         Derek Lyons for help with some routines
  418.         Richard Steiner for ditribution info.
  419.         William Rountree for help with routines       Sysop Prime Base BBS
  420.  
  421.         Thank you all. I would also like to thank everyone who registered
  422.  there copy of ListMaster.
  423.  
  424.  
  425.         Page 8 - For Your Information - Contacting the Author
  426.  
  427.  
  428.         ListMaster is pure QuickBasic Source Code. I used no libraries to
  429.  write it. If there is something special you would like ListMaster to do then
  430.  notify me and I can make a personalized copy for you or add it to the next
  431.  update.
  432.         If you have a copy od BRUN45.EXE and are running short on disk space
  433.  then I can Compile you a copy requiring BRUN45.EXE. This copy is about 50K
  434.  where the copy requiring BRUN45.EXE is only about 9K. Plus only 5K with
  435.  PkLite.
  436.         I am always happy to hear comment's so please give your opinion.
  437.  
  438.         I can be contacted on the following Bulletin Board's:
  439.  
  440.         Prime Base BBS (206) 871-9539  <- Support Board
  441.         Darkstar's BBS (206) 871-3965
  442.         Sports Complex (206) 692-2388
  443.         Vox Populi BBS (206) 895-1376
  444.  
  445.         I can also be contacted through the following mail networks:
  446.  
  447.         RIME - Shareware, QuickBasic, TurboPascal, Programming
  448.         MetroLink - Shareware
  449.         Fido - Shareware, Programming, QuickBasic
  450.  
  451.         The latest public versions of ListMaster Pro can be found on the
  452.         following Bulletin Boards across North America:
  453.  
  454.         Prime Base BBS (206) 871-9539        Darkstar's BBS (206) 871-3965
  455.         Thundercat BBS (206) 613-0688        Channel 1 BBS  (617) 354-7077
  456.         Exec-Pc BBS    (414) 789-4210        PC ToyShop BBS (503) 686-5055
  457.         Running Board  (321) 229-5623        Vox Populi BBS (206) 895-1376
  458.  
  459.  
  460.         Remember that ListMaster is Shareware and Registration is only $5.
  461.         Please Register it by filling out Register.Txt and sending it to me
  462.         with a check or money order for $5 made out to Garrett Whitney.
  463.  
  464.         QuickBasic is a Registered Trademark of Microsoft Inc.
  465.         PkLite is a Registered Trademark of PkWare & Phil Katz
  466.         PkZip is a Registeres Trademark of PkWare & Phil Katz
  467.         WGM-DMS is a Registered Trademark of Wayne G. Maas
  468.         Spitfire is a Registered Trademark of Buffaloe Creek Softare
  469.         PcBoard is a Registered Trademark of Clark Development Company
  470.         Wildcat! is a Registered Trademark of Mustang Software
  471.  
  472.  
  473. ───────────────────────────────────────────────────────────────────────────────
  474.           ListMaster v1.7  |  Garrett Whitney  |  Gamma Software Design
  475. ───────────────────────────────────────────────────────────────────────────────
  476.